feat(monitor): introduce MonitorStatus #780
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do?
In regard of #775, This PR introduces a new interface
MonitorStatus
that encapsulatesMonitor
but addsRecordJobTimingStatus(startTime, endTime time.Time, id uuid.UUID, name string, tags []string, status JobStatus, err error)
, to allow recording a Job with its name, tags, start & end time, as well as the job status and error. I choose to add a new interface instead of changingMonitor
to prevent introducing a breaking change.Which issue(s) does this PR fix/relate to?
Fixes #775
List any changes that modify/break current functionality
none
Have you included tests for your changes?
Did you document any new/modified functionality?
example_test.go
(ExampleWithMonitor()
is commented out :D)README.md
Notes
I believe having the
JobStatus
anderror
inRecordJobTiming
, definitely make sense, in case you're fine with it we can also just extendMonitor
even if it means having a breaking change ...